Readme v2.0

ATROPHY PRESENTS

                        ============
                         GODFATHERS
                        ============


Version    : 2.0
Date       : July 11th 2021
Author     : Hypov8

Based on the Godfather 1.6 code:-

Version    : 1.6
Date       : April 9th 2001
Author     : Warren "Pigwhistler" Jacobs
Extra code : Jason "Rat Instinct" Lucas
Email      : Pigwhistler@atrophy.co.uk
WWW page   : www.atrophy.co.uk

Index

1) The Game
1.1) About
1.2) The rules
1.3) So whats in it for me?
1.4) Whats new on the display?
1.5) Installing and running
1.6) New commands
1.7) GSlog support


1) THE GAME

Scenario:
"Hey kid, I think i've got a job for you."
You look into the eyes of the man stood before you, the godfather - you know he's testing you.
"Go for it" You say.
The Godfather smiles. "I want you to whack someone for me, do a good job, and I'll reward you. Screw it up, and you're not going to be around to be my problem anymore."
"When do I start?" You ask.
The Godfather hands you a pistol. "You already have."
 

1.1) About

Starting as a new recruit, you need to work your way up the ranks of the family to ultimately become the Godfather. There are others that stand in your way though, and these must be ruthlessly executed, for they will stop at nothing to remove you from the race to become the Godfather. Have you got what it takes?
You join each map as a new recruit, and get promoted by gaining kills. Promotion has its benefits (extra health, better starting weapons, some armour) and also its drawbacks (lower level kills give you less experience points).

The levels and bonuses are as follows:

(The following table looks poo in this readme unless read full screen at 1024*768! or greater.

---------------------------------------------------------------------------------------------------------------------
- key for table:												    -
- St       - 	Starting											    -
- EPNFL    - 	Experience Points Needed For Level - how many points you need to start with these bonuses           -	
- EPGFK    - 	Experience Points Gained For Kill - how many points you get when you kill someone at this level	    -
- 50-HJL   - 	50 armour points for Helmet, Jacket & Leg Armour       						    -
- CC       - 	Cooling Clip											    -
- LI       -    Level Indicator											    -
---------------------------------------------------------------------------------------------------------------------
LEVEL  	     LI	  St.Health  	Max.Health  	St.Bonus  	St.Ammo  	St.Armour  	EPNFL    	EPGFK
---------------------------------------------------------------------------------------------------------------------
Recruit       0	     75  	    75  	  pistol	   50		  None  	   0  		  5  
---------------------------------------------------------------------------------------------------------------------
Lookout       1	     75 	   100  	Magnum Mod  	   50	  	  None  	  30  		 10  
---------------------------------------------------------------------------------------------------------------------
Thug  	      2	    100		   125  	 Shotgun  	   24		  None  	 100  		 15  
---------------------------------------------------------------------------------------------------------------------
Mobster       3	    125		   150  	Tommy Gun  	  100		  None  	 200  		 25  
---------------------------------------------------------------------------------------------------------------------
Hitman        4	    125		   175  	Tommy Gun  	  200		25-HJL  	 400  		 40  
---------------------------------------------------------------------------------------------------------------------
Leuitenant    5	    150		   200  	    HMG  	   30	        50-HJL 		 700  		 50  
---------------------------------------------------------------------------------------------------------------------
Crime-Lord    6     175		   200  	 HMG + CC  	   30	 	75-HJL		1000  		 75  
---------------------------------------------------------------------------------------------------------------------

Each game's experience point limit is 1500 frags(though this is definable by the server admin), which, when hit, will result in a Crime-Lord becoming "The Godfather" and winning the game. The game ends as per normal, and you are all dropped back into the next map as Recruits again. A time limit can be set and the winner in this scenario will be the player with the most experience points (frags).

Of course, if you are an exceptional player, and you hit Crime-Lord level before anyone has even made mobster, you'll only be getting a maximum of 15 experience points per kill (look at the chart above), meaning you'd need to kill 24 thugs to become Godfather. If the game is more balanced however, and you find yourself in the company of other Crime-Lords, you would only need to kill five of them to become the Godfather.

Suicides are also more painful the higher up the ranks you go. You may be trapped in a room and think to take out an opponent in a suicidal grenade attack. However, if you are a Crime-Lord and they're a recruit, you're going to lose 70 experience points for your pains (gain 5 for the kill - then lose 75 for a suicide = 70), which might drop you back down to Leuitenant ranking, so the higher up the levels you go, the more you have to lose. Of course, the situation may be reversed and a suicide attack as a recruit on a Crime-Lord will gain you 70 experience points! Enough to take you up to the higher ranks of the thugs, but then the Crime-Lords get more points when they frag you. 

Also, once you reach level 4 (Hitman) - When you are killed by a player who is a lower level than you, you now lose frags equivalent to the difference in your levels. e.g. a level 6 player (exp modifier 75) is killed by a Level 4 player (exp modifier 40), the level 4 player would gain 75 points for killing you, and the level 6 player would lose 35 experience for being killed by a level 4 player (75-40). e.g. (again) a level 5 player (exp modifier 50) is killed by a Level 3 player (exp modifier 25), the level 3 player would gain 50 points for the kill, and the level 5 player would lose 25 experience points for being killed by a level 3 player (50-25).

Remember - just like share prices - levels can go down as well as up. 


1.2) The rules.

Kill everyone, but the higher the level of the people you kill, the quicker you'll get to battle for the title of "Godfather".


1.3) So whats in it for me?

Something unique in Kingpin - Levels. There are great mods coming out that deal with "Classes" and that is different. Here you have to fight tooth and claw to get to the higher levels. The weapons given to the higher levels on startup can still be gained by the lower levels to even the balance, but its the armour and health bonuses that make all the difference - and where else can you battle on a map to gain 1500 frags in 30 minutes!


1.4) Whats new on the display?

Well you'll notice that frags aren't just a non-descript number in the top corner anymore. No Siree, you now have "Experience Points".

You'll notice a big difference when you start fragging too. The largest single increase that can occur is when you kill a Crime-Lord. That way you'll gain 75 experience points whatever level you are.

Just below this is an indicator showing your current level - a number 0 to 6. 
Whenever anyone gains a level, you'll be notified at the top of your screen (where the death-messages come up). You'll also be notified when anyone drops a level too.

New to version 1.0 is the leaderboard display, just above your ammo. This shows you your ranking out of the players in the level, so you can easily see at a glance how close you are to the leaders. Also you'll notice your screen flash a couple of times when you join (using the default server.cfg file). While your screen is flashing you are invulnerable. This should stop respawn campers :-). However, it is up to the server admins if they want to set this. By setting the variable to 0, the respawn protection is ignored. You can tell if a player is invul by a red glow around their weapon. The maximum time allowed for protection is 5 seconds (a lot) - i recommend 2 seconds to allow you to get out of those tricky situations.
Respawn protection only works for levels 0 - 2 (recruit, look-out, thug) - once you reach mobster you should be able to survive a rocket blast and you can fire back with your machine gun.

New to version 1.1-1.2 is the points to next level on screen so that you have a better idea of whats happening. Also everyone's level has been added to the score table so youe can see how well each player is doing.

New to version 1.5 is the PlayerGlow. If this is turned on, players weapons glow to denote their level. The colour code is:

Level 0: No Glow    	(Recruit)
Level 1: Red		(Look-Out)
Level 2: Green		(Thug)
Level 3: Dark Blue	(Mobster)
Level 4: Yellow		(Hitman)
Level 5: Purple		(Lieutenant)
Level 6: Cyan		(Crime-Lord)

1.5) Installing and running.

If you are just a client wanting to connect to a game you don't need to do anything except understand what's going on. You're obviously a good-mannered gamer in that you've read this far already - so you don't seem like the type to join the server and say things like "Why do I start with 75 health?" or "why did i just gain 15 frags for a kill". Good for you.
If you're a server admin, I won't patronise you by explaining in kiddy talk what you already know.

Just unzip all the files into your Kingpin folder and this will place all the files in a new folder called godfather. Once unzipped you should find a batch file called server.bat - simply run this and get your friends to connect to your server. It is set to cycle through the standard KPDM1-5, but is playable on any map.

New in version 0.95, MOTD support. Server admins can now change the MOTD that comes up when you join a server. A sample one is included in the zip. Just change the text to say what you'd like, but try to keep it short as it can cause problems with client overflows on map changes.

There is also a dedicatedserver.bat so you can run a dedicated server.

1.6) New commands.

There are three new client commands in Godfather mod - "showtable", "showstats" and "teleport".
You can also bind keys to perform a specific taunt or a random taunt.

"Showtable" -  this table shows you info about each level - starting health, max health, starting gun, ammo and armour for each level, points required to reach each level and how many points you receive for killing that level. 

"showstats" - gives you a breakdown of how well your doing, this also displays the leaders stats.
 
"teleport" - If this option is turned on you can teleport 3 times in each level by pressing k. You teleport to nearby spawn point.

"teleport_add" - set a new teleport location


1.7) Game modes.

gamemode 1 - regular godfather

gamemode 2 - reverse godfather

gamemode 3 - weapon-mod godfather (no pickups)

gamemode 4 - real-mode + regular godfather 

gamemode 5 - real-mode + reverse godfather

gamemode 6 - real-mode + weapon-mod godfather (no pickups)

1.8) weapon mod tables

weapon-mod 
level 0. "Crowbar", "Pistol", "magnum"
level 1. "Crowbar", "Pistol", "shotgun"
level 2. "Crowbar", "Pistol", "tommygun", 
level 3. "Crowbar", "Pistol", "FlameThrower",
level 4. "Crowbar", "Pistol", "Grenade Launcher",
level 5. "Crowbar", "Pistol", "Bazooka", 
level 6. "Crowbar", "Pistol", "Heavy machinegun", "coolmod"

weapon-mod. realmode
level 0. "Crowbar", "Pistol",
level 1. "Crowbar", "Pistol", "magnum"
level 2. "Crowbar", "shotgun",
level 3. "Crowbar", "shotgun", "SG reload mod", "magnum"
level 4. "Crowbar", "tommygun",
level 5. "Crowbar", "tommygun", "Pistol", "magnum"
level 6. "Crowbar", "tommygun", "shotgun", "Pistol", "magnum"

